home *** CD-ROM | disk | FTP | other *** search
/ Java Programmer's Toolkit / Java Programmer's Toolkit.iso / applets / collectn / keyed.jav < prev    next >
Text File  |  1995-10-14  |  1KB  |  43 lines
  1. /*
  2.   File: Keyed.java
  3.  
  4.   Originally written by Doug Lea and released into the public domain. 
  5.   Thanks for the assistance and support of Sun Microsystems Labs, Agorics 
  6.   Inc, Loral, and everyone contributing, testing, and using this code.
  7.  
  8.   History:
  9.   Date     Who                What
  10.   24Sep95  dl@cs.oswego.edu   Create from collections.java  working file
  11.  
  12. */
  13.   
  14. package collections;
  15.  
  16. import java.util.Enumeration;
  17. import java.util.NoSuchElementException;
  18.  
  19. /**
  20.  *
  21.  *
  22.  * Keyed is an interface most useful in association with SortedCollections.
  23.  * Any class implementing Keyed contains method key, that returns
  24.  * an object serving as a sorting key for the rest of the object.
  25.  * <P>
  26.  * The DefaultComparator class checks to see if its arguments
  27.  * are Keyed, and if so uses the keys as the basis for comparison.
  28.  * @author Doug Lea
  29.  * @version 0.93
  30.  *
  31.  * <P> For an introduction to this package see <A HREF="index.html"> Overview </A>.
  32. **/
  33.  
  34. public interface Keyed {
  35.  
  36. /**
  37.  * Return an object serving as a comparison key
  38. **/
  39.  
  40.   public Object  key();
  41. };
  42.  
  43.